Move documentation to Gitbook #206
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeffpaul
approved these changes
Apr 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR moves the bulk of the documentation from the
README.mdfile over to/docswhich can be handled by Gitbook.This is a preview of how it will look like: https://wp-mock.gitbook.io/documentation/general/introduction but the source of truth will be this PR - the current copy on GitBook is not synced with Git currently and incomplete. I think we need to initiate a diff from this repo, sync won't be bidirectional.
Note that the sources of documentation will always be in this repository under
/docs-- if some day we switch away from GitBook the documentation will still be readable - as a matter of fact can be read from within the repository. Editing the docs will also be easy through regular PRs.For a preview of the updated
README.md: https://github.com/10up/wp_mock/tree/chore/move-docs-to-gitbookCloses: #199
Details
After this is merged we need to make sure the docs will be properly synced to Gitbook from the markdown files in
/docs.The
CREDITS.mdfile is removed - the list of contributors is automatically generated by GitHub and furthermore we can make attributions in the generated changelogs. There's no need to manually maintain a static file of contributors.